<!DOCTYPE html>
<html lang="en">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
    <meta charset="utf-8"/>
    <title>    ZimbraSoapPhp &raquo; \Zm_Account
</title>
    <meta name="author" content=""/>
    <meta name="description" content=""/>

            <link href="../css/template.css" rel="stylesheet" media="all"/>
    
            <!--[if lt IE 9]>
        <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
        <![endif]-->
        <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
        <script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
        <script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
        <script src="../js/bootstrap.js" type="text/javascript"></script>
        <script src="../js/template.js" type="text/javascript"></script>
        <script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
    
            <link rel="shortcut icon" href="../img/favicon.ico"/>
        <link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
        <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
        <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
    </head>
<body>

        <div class="navbar navbar-fixed-top">
        <div class="navbar-inner">
            <div class="container">
                <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
                    <span class="icon-bar"></span> <span class="icon-bar"></span>
                    <span class="icon-bar"></span> </a>
                <a class="brand" href="../index.html">ZimbraSoapPhp</a>

                <div class="nav-collapse">
                    <ul class="nav">
                        <li class="dropdown">
                            <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                API Documentation <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                                                                            </ul>
                        </li>
                        <li class="dropdown" id="charts-menu">
                            <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                Charts <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                <li>
                                    <a href="../graph_class.html">
                                        <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
                                    </a>
                                </li>
                            </ul>
                        </li>
                        <li class="dropdown" id="reports-menu">
                            <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                Reports <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                <li>
                                    <a href="../errors.html">
                                        <i class="icon-list-alt"></i>&#160;Errors
                                    </a>
                                </li>
                                <li>
                                    <a href="../markers.html">
                                        <i class="icon-list-alt"></i>&#160;Markers
                                    </a>
                                </li>
                                <li>
                                    <a href="../deprecated.html">
                                        <i class="icon-list-alt"></i>&#160;Deprecated
                                    </a>
                                </li>
                            </ul>
                        </li>
                    </ul>
                </div>
            </div>
        </div>
        <div class="go_to_top">
            <a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
        </div>
    </div>
    
    <div id="___" class="container">
        <noscript>
            <div class="alert alert-warning">
                Javascript is disabled; several features are only available if Javascript is enabled.
            </div>
        </noscript>

        
            <style>
        .deprecated h2 {
            text-decoration: line-through;
        }
    </style>
    <div class="row">
        <div class="span4">
                    <div class="btn-group view pull-right" data-toggle="buttons-radio">
        <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
        <button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
    </div>
    <div class="btn-group visibility" data-toggle="buttons-checkbox">
        <button class="btn public active" title="Show public elements">Public</button>
        <button class="btn protected" title="Show protected elements">Protected</button>
        <button class="btn private" title="Show private elements">Private</button>
        <button class="btn inherited active" title="Show inherited elements">Inherited</button>
    </div>

        <ul class="side-nav nav nav-list">
        <li class="nav-header">
            <i class="icon-custom icon-method"></i> Methods
            <ul>
                                                                                                    <li class="method public">
        <a href="#method___construct" title="__construct :: Constructor">
            <span class="description">Constructor</span><pre>__construct</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_accountExists" title="accountExists :: accountExists">
            <span class="description">accountExists</span><pre>accountExists</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_addAccountAlias" title="addAccountAlias :: addAccountAlias">
            <span class="description">addAccountAlias</span><pre>addAccountAlias</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_createAccount" title="createAccount :: createAccount">
            <span class="description">createAccount</span><pre>createAccount</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_deleteAccount" title="deleteAccount :: deleteAccount">
            <span class="description">deleteAccount</span><pre>deleteAccount</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_fetchAccounts" title="fetchAccounts :: fetchAccounts">
            <span class="description">fetchAccounts</span><pre>fetchAccounts</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAccountAliases" title="getAccountAliases :: getAccountAliases">
            <span class="description">getAccountAliases</span><pre>getAccountAliases</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAccountCos" title="getAccountCos :: getAccountCos">
            <span class="description">getAccountCos</span><pre>getAccountCos</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAccountId" title="getAccountId :: getAccountId">
            <span class="description">getAccountId</span><pre>getAccountId</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAccountInfo" title="getAccountInfo :: getAccountInfo">
            <span class="description">getAccountInfo</span><pre>getAccountInfo</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAccountOption" title="getAccountOption :: getAccountOption">
            <span class="description">getAccountOption</span><pre>getAccountOption</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAccountOptions" title="getAccountOptions :: getAccountOptions">
            <span class="description">getAccountOptions</span><pre>getAccountOptions</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAccountStatus" title="getAccountStatus :: getAccountStatus">
            <span class="description">getAccountStatus</span><pre>getAccountStatus</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getAllAccounts" title="getAllAccounts :: getAllAccounts">
            <span class="description">getAllAccounts</span><pre>getAllAccounts</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_getCosId" title="getCosId :: getCosId">
            <span class="description">getCosId</span><pre>getCosId</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_modifyAccount" title="modifyAccount :: modifyAccount">
            <span class="description">modifyAccount</span><pre>modifyAccount</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_removeAccountAlias" title="removeAccountAlias :: removeAccountAlias">
            <span class="description">removeAccountAlias</span><pre>removeAccountAlias</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_renameAccount" title="renameAccount :: renameAccount">
            <span class="description">renameAccount</span><pre>renameAccount</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_setAccountCos" title="setAccountCos :: setAccountCos">
            <span class="description">setAccountCos</span><pre>setAccountCos</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_setAccountPassword" title="setAccountPassword :: setAccountPassword">
            <span class="description">setAccountPassword</span><pre>setAccountPassword</pre>
        </a>
    </li>

                                                                                                        <li class="method public">
        <a href="#method_setAccountStatus" title="setAccountStatus :: setAccountStatus">
            <span class="description">setAccountStatus</span><pre>setAccountStatus</pre>
        </a>
    </li>

                                                </ul>
        </li>
        <li class="nav-header protected">» Protected
            <ul>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                </ul>
        </li>
        <li class="nav-header private">» Private
            <ul>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                </ul>
        </li>
        <li class="nav-header">
            <i class="icon-custom icon-constant"></i> Constants
            <ul>
                            </ul>
        </li>
    </ul>


        </div>

        <div class="span8">
            <div class="element class">
                <h1>Zm_Account</h1>
                <small style="display: block; text-align: right">
                                                        </small>
                <p class="short_description">Zm_Account is a class which allows to manage Zimbra accounts via SOAP</p>
                <div class="details">
                    <div class="long_description">
                        <p>You may create, modify, rename, delete and get the attributes of a Zimbra account using this class</p>
<p>For the usage examples of all class methods check the source code of test.php</p>
                    </div>
                    <table class="table table-bordered">
                                                                                    <tr>
                                    <th>
                                        package
                                                                            </th>
                                    <td>
                                                                                    
                                                                                <p>ZimbraSoapPhp</p>
                                    </td>
                                </tr>
                                                                                                                                                                                </table>

                    <h3><i class="icon-custom icon-method"></i> Methods</h3>
                                                                <a id="method___construct"></a>
                        <div class="element clickable method public  method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
                            <h2>Constructor</h2>
                            <pre>__construct(\Zm_Auth $auth) </pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    
                                                </th>
                                                <td>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$auth</h4>
                                                <code><a href="../classes/Zm_Auth.html">\Zm_Auth</a></code><p><p>soap authentication</p></p>
                                            </div>
                                                                            
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_accountExists"></a>
                        <div class="element clickable method public  method_accountExists" data-toggle="collapse" data-target=".method_accountExists .collapse">
                            <h2>accountExists</h2>
                            <pre>accountExists(string $idOrNameAccount, string $type = &quot;auto&quot;) : boolean</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>boolean</code><p><p>exists</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_addAccountAlias"></a>
                        <div class="element clickable method public  method_addAccountAlias" data-toggle="collapse" data-target=".method_addAccountAlias .collapse">
                            <h2>addAccountAlias</h2>
                            <pre>addAccountAlias(string $idOrNameAccount, string $alias, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$alias</h4>
                                                <code>string</code><p><p>account alias</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_createAccount"></a>
                        <div class="element clickable method public  method_createAccount" data-toggle="collapse" data-target=".method_createAccount .collapse">
                            <h2>createAccount</h2>
                            <pre>createAccount(string $name, string $password, array $attrs = array()) : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$name</h4>
                                                <code>string</code><p><p>account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$password</h4>
                                                <code>string</code><p><p>password</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$attrs</h4>
                                                <code>array</code><p><p>an optional array containing the account attributes to be set</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>the new account's id</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_deleteAccount"></a>
                        <div class="element clickable method public  method_deleteAccount" data-toggle="collapse" data-target=".method_deleteAccount .collapse">
                            <h2>deleteAccount</h2>
                            <pre>deleteAccount(string $idOrNameAccount, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_fetchAccounts"></a>
                        <div class="element clickable method public  method_fetchAccounts" data-toggle="collapse" data-target=".method_fetchAccounts .collapse">
                            <h2>fetchAccounts</h2>
                            <pre>fetchAccounts(string $ldapQuery, array $attrList, string $nameDomain = null) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    author
                                                </th>
                                                <td>
                                                                                                                                                                        
                                                                                                                                                                        <p>Marc Lamouche <a href="mailto:marc.lamouche@ined.fr">marc.lamouche@ined.fr</a></p>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$ldapQuery</h4>
                                                <code>string</code><p><p>LDAP-style filter string (RFC 2254)</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$attrList</h4>
                                                <code>array</code><p><p>names of requested attributes</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$nameDomain</h4>
                                                <code>string</code><p><p>domain name to restrict search request</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations for accounts as specified in $ldapQuery</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAccountAliases"></a>
                        <div class="element clickable method public  method_getAccountAliases" data-toggle="collapse" data-target=".method_getAccountAliases .collapse">
                            <h2>getAccountAliases</h2>
                            <pre>getAccountAliases(string $idOrNameAccount, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>aliases</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAccountCos"></a>
                        <div class="element clickable method public  method_getAccountCos" data-toggle="collapse" data-target=".method_getAccountCos .collapse">
                            <h2>getAccountCos</h2>
                            <pre>getAccountCos(string $idOrNameAccount, string $returnType = &quot;NAME&quot;, string $type = &quot;auto&quot;) : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$returnType</h4>
                                                <code>string</code><p><p>get the COS ID or NAME</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>COS id or name</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAccountId"></a>
                        <div class="element clickable method public  method_getAccountId" data-toggle="collapse" data-target=".method_getAccountId .collapse">
                            <h2>getAccountId</h2>
                            <pre>getAccountId(string $name) : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$name</h4>
                                                <code>string</code><p><p>account name</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>account id</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAccountInfo"></a>
                        <div class="element clickable method public  method_getAccountInfo" data-toggle="collapse" data-target=".method_getAccountInfo .collapse">
                            <h2>getAccountInfo</h2>
                            <pre>getAccountInfo(string $idOrNameAccount, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAccountOption"></a>
                        <div class="element clickable method public  method_getAccountOption" data-toggle="collapse" data-target=".method_getAccountOption .collapse">
                            <h2>getAccountOption</h2>
                            <pre>getAccountOption(string $idOrNameAccount, string $optName, integer $multisingle = ATTR_SINGLEVALUE, string $type = &quot;auto&quot;) : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$optName</h4>
                                                <code>string</code><p><p>name of the option to get</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$multisingle</h4>
                                                <code>integer</code><p><p>(ATTR_SINGLEVALUE, ATTR_MULTIVALUE)</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>option</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAccountOptions"></a>
                        <div class="element clickable method public  method_getAccountOptions" data-toggle="collapse" data-target=".method_getAccountOptions .collapse">
                            <h2>getAccountOptions</h2>
                            <pre>getAccountOptions(string $idOrNameAccount, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>options</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAccountStatus"></a>
                        <div class="element clickable method public  method_getAccountStatus" data-toggle="collapse" data-target=".method_getAccountStatus .collapse">
                            <h2>getAccountStatus</h2>
                            <pre>getAccountStatus(string $idOrNameAccount, string $type = &quot;auto&quot;) : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>status</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getAllAccounts"></a>
                        <div class="element clickable method public deprecated method_getAllAccounts" data-toggle="collapse" data-target=".method_getAllAccounts .collapse">
                            <h2>getAllAccounts</h2>
                            <pre>getAllAccounts(string $idOrNameDomain, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                                    <tr>
                                                <th>
                                                    deprecated
                                                </th>
                                                <td>
                                                                                                                                                                        
                                                                                                                                                                        <p>it may take a long time to complete and fail on servers with lots of accounts</p>
<p>use fetchAccounts instead</p>
                                                                                                    </td>
                                            </tr>
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameDomain</h4>
                                                <code>string</code><p><p>domain id or domain name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the domain (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations for all accounts</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_getCosId"></a>
                        <div class="element clickable method public  method_getCosId" data-toggle="collapse" data-target=".method_getCosId .collapse">
                            <h2>getCosId</h2>
                            <pre>getCosId(string $name) : string</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$name</h4>
                                                <code>string</code><p><p>the COS name</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>string</code><p><p>COS id</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_modifyAccount"></a>
                        <div class="element clickable method public  method_modifyAccount" data-toggle="collapse" data-target=".method_modifyAccount .collapse">
                            <h2>modifyAccount</h2>
                            <pre>modifyAccount(string $idOrNameAccount, array $attrs = array(), string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$attrs</h4>
                                                <code>array</code><p><p>an array containing the account attributes to be set</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_removeAccountAlias"></a>
                        <div class="element clickable method public  method_removeAccountAlias" data-toggle="collapse" data-target=".method_removeAccountAlias .collapse">
                            <h2>removeAccountAlias</h2>
                            <pre>removeAccountAlias(string $idOrNameAccount, string $alias, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$alias</h4>
                                                <code>string</code><p><p>account alias</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_renameAccount"></a>
                        <div class="element clickable method public  method_renameAccount" data-toggle="collapse" data-target=".method_renameAccount .collapse">
                            <h2>renameAccount</h2>
                            <pre>renameAccount(string $idOrNameAccount, string $newName, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$newName</h4>
                                                <code>string</code><p><p>new account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_setAccountCos"></a>
                        <div class="element clickable method public  method_setAccountCos" data-toggle="collapse" data-target=".method_setAccountCos .collapse">
                            <h2>setAccountCos</h2>
                            <pre>setAccountCos(string $idOrNameAccount, string $cosName, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$cosName</h4>
                                                <code>string</code><p><p>the COS name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_setAccountPassword"></a>
                        <div class="element clickable method public  method_setAccountPassword" data-toggle="collapse" data-target=".method_setAccountPassword .collapse">
                            <h2>setAccountPassword</h2>
                            <pre>setAccountPassword(string $idOrNameAccount, string $password, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$password</h4>
                                                <code>string</code><p><p>password</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                                            <a id="method_setAccountStatus"></a>
                        <div class="element clickable method public  method_setAccountStatus" data-toggle="collapse" data-target=".method_setAccountStatus .collapse">
                            <h2>setAccountStatus</h2>
                            <pre>setAccountStatus(string $idOrNameAccount, string $status, string $type = &quot;auto&quot;) : array</pre>
                            <div class="labels">
                                                                                                                                                                                            </div>

                            
                            <div class="row collapse">
                                <div class="detail-description">
                                    <div class="long_description"></div>

                                    <table class="table">
                                                                            </table>

                                                                            <h3>Arguments</h3>
                                                                                    <div class="subelement argument">
                                                <h4>$idOrNameAccount</h4>
                                                <code>string</code><p><p>account id or account name</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$status</h4>
                                                <code>string</code><p><p>the status (active, maintenance, pending, locked, closed)</p></p>
                                            </div>
                                                                                    <div class="subelement argument">
                                                <h4>$type</h4>
                                                <code>string</code><p><p>value of the account (auto, name, id)</p></p>
                                            </div>
                                                                            
                                                                            <h3>Response</h3>
                                        <code>array</code><p><p>informations</p></p>
                                                                    </div>
                            </div>

                        </div>
                    
                    
                                                                <h3><i class="icon-custom icon-property"></i> Properties</h3>
                                                    <a id="property_auth"> </a>
                            <div class="element clickable property  private property_auth" data-toggle="collapse" data-target=".property_auth .collapse">
                                <h2>$auth</h2>
                                <pre>auth : \Zm_Auth</pre>
                                <div class="labels">
                                                                                                        </div>
                                <div class="row collapse">
                                    <div class="detail-description">
                                        <div class="long_description"></div>

                                        <table class="table">
                                                                                            <tr>
                                                    <th>
                                                        var
                                                    </th>
                                                    <td>
                                                                                                                    <p>soap authentication</p>
                                                                                                            </td>
                                                </tr>
                                                                                    </table>

                                                                                    <h3>Type(s)</h3>
                                            <code><a href="../classes/Zm_Auth.html">\Zm_Auth</a></code>
                                                                            </div>
                                </div>
                            </div>
                                                            </div>
            </div>
            <a id="\Zm_Account"></a>
            <ul class="breadcrumb">
                <li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
                    
    
    <li><span class="divider">\</span><a href="../namespaces/default.html">\</a></li>

                <li class="active"><span class="divider">\</span><a href="../classes/Zm_Account.html">Zm_Account</a></li>
            </ul>
        </div>
    </div>

    </div>

        <footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
            <a href="http://glyphicons.com/">Glyphicons</a>.<br/>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
            generated on Thu, 30 Oct 2014 16:10:50 +0000.<br/>
    </footer>
    </body>
</html>
